@lerna/project

What is @lerna/project?

@lerna/project is a part of the Lerna monorepo management toolset. It provides functionalities to manage and interact with the project structure in a monorepo setup. This includes reading and manipulating package.json files, managing dependencies, and handling versioning.

What are @lerna/project's main functionalities?

Reading Project Metadata

This feature allows you to read metadata about the project, such as the list of packages in the monorepo. The code sample demonstrates how to initialize a Project instance and retrieve the packages.

const { Project } = require('@lerna/project');
(async () => {
  const project = new Project();
  const projectMetadata = await project.getPackages();
  console.log(projectMetadata);
})();

Managing Dependencies

This feature helps in managing dependencies across the monorepo. The code sample shows how to get the dependency graph of the project.

const { Project } = require('@lerna/project');
(async () => {
  const project = new Project();
  const dependencies = await project.getDependencyGraph();
  console.log(dependencies);
})();

Handling Versioning

This feature allows you to handle versioning of the project. The code sample demonstrates how to retrieve the current version of the project.

const { Project } = require('@lerna/project');
(async () => {
  const project = new Project();
  const version = await project.getVersion();
  console.log(version);
})();

Other packages similar to @lerna/project

nx

Nx is a smart, fast, and extensible build system with first-class monorepo support and powerful integrations. It offers more advanced features compared to @lerna/project, such as caching, distributed task execution, and more.

yarn

Yarn is a package manager that doubles as a monorepo manager with its workspaces feature. It allows you to manage multiple packages within a single repository, similar to @lerna/project, but also focuses on dependency management and performance.

README

@lerna/project

Lerna project configuration

Configuration Resolution

Lerna's file-based configuration is located in lerna.json or the lerna property of package.json. Wherever this configuration is found is considered the "root" of the lerna-managed multi-package repository. A minimum-viable configuration only needs a version property; the following examples are equivalent:

{
  "version": "1.2.3"
}

{
  "name": "my-monorepo",
  "version": "0.0.0-root",
  "private": true,
  "lerna": {
    "version": "1.2.3"
  }
}

Any other properties on this configuration object will be used as defaults for CLI options of all lerna subcommands. That is to say, CLI options always override values found in configuration files (a standard practice for CLI applications).

Command-Specific Configuration

To focus configuration on a particular subcommand, use the command subtree. Each subproperty of command corresponds to a lerna subcommand (publish, create, run, exec, etc).

{
  "version": "1.2.3",
  "command": {
    "publish": {
      "loglevel": "verbose"
    }
  },
  "loglevel": "success"
}

In the example above, lerna publish will act as if --loglevel verbose was passed. All other subcommands will receive the equivalent of --loglevel success (much much quieter).

Changelog

3.21.0 (2020-05-13)

Bug Fixes

• publish: Canary releases without previous tags should not explode (c9eb590)

Features

• project: Add getPackagesSync() export (068bdd7)
• version: Ignore private packages completely with --no-private (a9b9f97)